.TH slurmrestd "8" "Slurm REST Daemon" "March 2020" "Slurm REST Daemon"

.SH "NAME"
slurmrestd \- Interface to Slurm via REST API.
.SH "SYNOPSIS"
\fBslurmrestd\fR [\fIOPTIONS\fR...] <\fI[host]:port\fR|\fIunix:/path/to/socket\fR>
.SH "DESCRIPTION"
\fBslurmrestd\fR is REST API interface for Slurm. It can be used in two modes:

.TP
Inetd Mode: slurmrestd will read and write to STDIN and STDOUT. It can detect if
it is connected to a socket or a locally TTY (interactive mode).

.TP
Listen Mode: slurmrestd will open a listening socket on each requested
host:port pair or UNIX socket.

.TP
.SH "OPTIONS"

.TP
\fB[host]:port\fR
Hostname and port to listen against. Host may be (IPv4/IPv6) IP or a resolvable
hostname. Hostnames are only looked up at startup and do not change for the
life of the process. Host is optional; if not provided slurmrestd will listen on
all network interfaces.
.TP
\fBunix:/path/to/socket\fR
Listen on local UNIX socket. Must have permission to create socket in
filesystem.
.TP
\fB\-a <authentication plugins>\fR
Comma delimited list of authentication plugins to load.
Set to "list" to dump a list of the possible plugins to load.
Defaults: all builtin supported REST authentication plugins.
.TP
\fB\-f <file>\fR
Read Slurm configuration from the specified file. See \fBNOTES\fR below.
.TP
\fB\-g <group id>\fR
Change group id (and drop supplemental groups) before processing client
request. This should be a unique group with no write access or special
permissions. Do not set this user to SlurmUser or root.
.TP
\fB\-h\fR
Help; print a brief summary of command options.
.TP
\fB\-s <OpenAPI plugins to load>\fR
Comma delimited list of OpenAPI plugins.
Set to "list" to dump a list of the possible plugins to load.
Defaults: all builtin supported OpenAPI plugins.
.TP
\fB\-t <THREAD COUNT>\fR
Specify number of threads to use to process client connections.
Ignored in inetd mode. Default: 20
.TP
\fB\-u <user id>\fR
Change user id before processing client request. This should be a unique group
with no write access or special permissions. Do not set this user to SlurmUser
or root.
.TP
\fB\-v\fR
Verbose operation. Multiple \fB\-v\fR's increase verbosity.
Higher verbosity levels will have significant performance impact.
.TP
\fB\-V\fR
Print version information and exit.

.SH "ENVIRONMENT VARIABLES"
The following environment variables can be used to override settings
compiled into slurmctld.
.TP 20
\fBSLURM_CONF\fR
The location of the Slurm configuration file.
.TP
\fBSLURMRESTD_AUTH_TYPES\fR
Set allowed authentication types. See \fB\-a\fR
.TP
\fBSLURMRESTD_DEBUG\fR
Set debug level explicitly. Valid values are 1-10. See \fB\-v\fR
.TP
\fBSLURMRESTD_LISTEN\fR
Comma delimited list of host:port pairs or unix sockets to listen on.
.TP
\fBSLURMRESTD_OPENAPI_PLUGINS\fR
Comma delimited list of OpenAPI plugins to load. See \fB\-s\fR

.SH "SIGNALS"
.TP
\fBSIGINT\fR
\fBslurmrestd\fR will shutdown cleanly.
.TP
\fBSIGPIPE\fR
This signal is explicitly ignored.

.SH "NOTES"
slurmrestd is designed to run with AuthAltTypes outside of the Munge cluster
when configured AuthAltTypes supports this.

.SH "COPYING"
Copyright (C) 2019-2020 SchedMD LLC.
.LP
This file is part of Slurm, a resource management program.
For details, see <https://slurm.schedmd.com/>.
.LP
Slurm is free software; you can redistribute it and/or modify it under
the terms of the GNU General Public License as published by the Free
Software Foundation; either version 2 of the License, or (at your option)
any later version.
.LP
Slurm is distributed in the hope that it will be useful, but WITHOUT ANY
WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
details.

.SH "SEE ALSO"
\fBslurm.conf\fR(5), \fBslurmctld\fR(8), \fBslurmdbd\fR(8)
